home *** CD-ROM | disk | FTP | other *** search
/ AmigActive 24 / AACD 24.iso / AACD / Online / Epic4 / share / epic / help / 6_functions / rename < prev    next >
Text File  |  2001-03-21  |  699b  |  24 lines
  1. Synopsis:
  2.    $rename(<source> <destination>)
  3.  
  4. Technical:
  5.    This function gives the specified file a new name.  Files cannot be
  6.    moves to different directories with this function.
  7.  
  8. Practical:
  9.    Naturally, this function is useful any time a file needs to be renamed.
  10.    One use for it might be to back up your .ircrc before doing a SAVE, just
  11.    in case something goes wrong before the command is completed.
  12.  
  13. Returns:
  14.     0   file renamed successfully
  15.    -1   error during rename attempt
  16.  
  17. Examples:
  18.    $rename(~/.ircrc ~/.ircrc.bak)              returns 0 if successful
  19.    $rename(/etc/passwd /etc/hahaha)            probably will return -1
  20.  
  21. See Also:
  22.    fexist(6); unlink(6)
  23.  
  24.